---
id: cmd-options
title: Temporal CLI command options reference
sidebar_label: cmd options
description: Discover how to manage Temporal Workflows, from Activity Execution to Workflow Ids, using clusters, cron schedules, dynamic configurations, and logging. Perfect for developers.
toc_max_heading_level: 4
keywords:
  - actions
  - active cluster
  - activity
  - activity execution
  - activity id
  - address
  - archival
  - backfill
  - batch job
  - build
  - build id
  - ca-certificate
  - calendar
  - certificate key
  - child workflows
  - cli reference
  - cluster
  - codec server
  - command-line-interface-cli
  - command-line-interface-cli,
  - concurrency control
  - configuration
  - context
  - continue-as-new
  - cron
  - cross-cluster-connection
  - data converters
  - endpoint
  - environment
  - event
  - event id
  - event type
  - events
  - external temporal and state events
  - failures
  - frontend
  - frontend address
  - frontend service
  - goroutine
  - grpc
  - history
  - http
  - interval
  - ip address
  - job id
  - log-feature
  - logging
  - logging and metrics
  - memo
  - metrics
  - namespace
  - namespace description
  - namespace id
  - namespace management
  - nondeterministic
  - notes
  - operation
  - operator
  - options-feature
  - overlap policy
  - pager
  - port
  - pragma
  - queries-feature
  - query
  - requests
  - reset point
  - resets-feature
  - retention policy
  - retries
  - reuse policy
  - schedule
  - schedule backfill
  - schedule id
  - schedule pause
  - schedule unpause
  - schedules
  - search attribute
  - search attributes
  - server
  - server options and configurations
  - sqlite
  - start-to-close
  - task queue
  - task queue type
  - temporal cli
  - temporal ui
  - time
  - time zone
  - timeout
  - timeouts and heartbeats
  - tls
  - tls server
  - uri
  - verification
  - visibility
  - web ui
  - workflow
  - workflow execution
  - workflow id
  - workflow run
  - workflow state
  - workflow task
  - workflow task failure
  - workflow type
  - workflow visibility
  - x509-certificate
tags:
  - Temporal CLI
---

## active-cluster

Active cluster name.

## activity-id

Identifies the Activity Execution.

## address

The host and port (formatted as host:port) for the Temporal Frontend Service.

## api-key

API key for request.

## archived

List archived Workflow Executions.

:::note

Caution: `--archived` is experimental.

:::

## build-id

Identifies the build to retrieve reachability information for.
Can be specified multiple times.

## calendar

Calendar specification in JSON `({"dayOfWeek":"Fri","hour":"17","minute":"5"})` or as a Cron string `("30 2 \* \* 5" or "@daily")`.

## catchup-window

Maximum allowed catch-up time if server is down.

## cluster

Cluster name.

## codec-auth

Sets the authorization header on requests to the Codec Server.

## codec-endpoint

Endpoint for a remote Codec Server.

## color

When to use color: auto, always, never. (default: auto)

## concurrency

Request concurrency.

## command-timeout

The command execution timeout. 0s means no timeout.

## cron

The Cron schedule can be formatted like the following:

```text
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
│ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday)
│ │ │ │ │
* * * * *
```

## data

Namespace data in a key=value format.

Values must be in JSON format.

## db-filename

File in which to persist Temporal state.
By default, Workflows are lost when the process dies.

## depth

The number of Child Workflows to fetch and expand.
Use `-1` to fetch Child Workflows at any depth.

## description

Namespace description or Nexus Endpoint description.
You may use Markdown formatting in the Nexus Endpoint description.

## description-file

Path to the Nexus Endpoint description file.
The contents of the description file may use Markdown formatting.

## detail

A provided reason for failing an Activity.

## dry-run

Simulate reset without resetting any Workflow Executions.

## dynamic-config-value

Dynamic config value, formatted as `KEY=JSON_VALUE`.
String values require quotation marks.

## email

Owner email.

## enable-connection

Enable cross-cluster connection.

## end-time

Backfill end time.

## env

Name of the environment to read environmental variables from.

## env-file

Path to environment settings file.
Defaults to `$HOME/.config/temporalio/temporal.yaml`.

## event-id

The Event Id for any Event after WorkflowTaskStarted you want to reset to (exclusive).
It can be WorkflowTaskCompleted, WorkflowTaskFailed or others.

## exclude-file

Input file that specifies Workflow Executions to exclude from resetting.

## execution-timeout

Timeout (in seconds) for a [Workflow Execution](/workflows#workflow-execution), including retries and `ContinueAsNew` tasks.

## existing-compatible-build-id

A Build Id that already exists in the version sets known by the Task Queue.
New Build Ids are stored in the version set containing this Id, making them compatible with the versions in that set.

## fields

Customize fields to print.
Set to 'long' to automatically print more of main fields.

## first-execution-run-id

Run update on the last execution in the chain that started with this Run Id.

## fold

Statuses for which Child Workflows will be folded in (this will reduce the number of information fetched and displayed).
Case-insensitive and ignored if `--no-fold` is supplied.

## follow

Follow the progress of a Workflow Execution.

## frontend-address

Frontend address of the remote Cluster.

## global

Flag to indicate whether a Namespace is a Global Namespace.

## grpc-meta

Contains gRPC metadata to send with requests (format: `key=value`).
Values must be in a valid JSON format.

## headless

Disable the Web UI.

## history-archival-state

Sets the history archival state.
Valid values are "disabled" and "enabled".

## history-uri

Optionally specify history archival URI (cannot be changed after first time archival is enabled).

## id-reuse-policy

Allows the same Workflow Id to be used in a new Workflow Execution.
Options: AllowDuplicate, AllowDuplicateFailedOnly, RejectDuplicate, TerminateIfRunning.

## identity

Specify operator's identity.

## input-file

Passes optional input for the Workflow from a JSON file.
If there are multiple JSON files, concatenate them and separate by space or newline.
Input from the command line will overwrite file input.

## input-parallelism

Number of goroutines to run in parallel.
Each goroutine processes one line for every second.

## input-separator

Separator for the input file. The default is a tab (`\t`).

## input

Use the `--input` command option to include data in the command.

This command option accepts a valid JSON string.
If the entity that the command is acting on accepts multiple parameters, pass "null" for null values within the JSON string.

The following is an example of starting a Workflow with the `--input` command option.
This Workflow expects a single string as a parameter:

```shell
temporal workflow start --input '"+1 555-555-5555"'
```

## interval

Interval duration, such as 90m, or 90m/13m to include phase offset.

## ip

IPv4 address to bind the frontend service to.
(default: 127.0.0.1)

## jitter

Jitter duration.

## job-id

Batch Job Id.

## limit

Number of items to print on a page.

## log-format

Set the log formatting.
Options: ["json", "pretty"].

## log-level

Set the log level.
Options: ["debug" "info" "warn" "error" "fatal"].

## max-field-length

Maximum length for each attribute field.

## max-sets

Limits how many compatible sets will be returned.
Specify 1 to return only the current default major version set.
0 returns all sets.

## memo

Set a memo on a schedule (format: key=value).
Use valid JSON formats for value.

## memo-file

Set a memo from a file.
Each line should follow the format key=value.
Use valid JSON formats for value.

## metrics-port

Port for `/metrics`.
Enabled by default with a randomly assigned port.

## name

Frontend address of the remote Cluster or the Endpoint name.

## namespace

Identifies a Namespace in the Temporal Workflow.

## namespace-id

Namespace Id.

## no-fold

Disable folding.
All Child Workflows within the set depth will be fetched and displayed.

## no-json-shorthand-payloads

Raw payload output, even if the JSON option was used.

## no-pager

Disables the interactive pager.

## non-deterministic

Reset Workflow Execution only if its last Event is `WorkflowTaskFailed` with a nondeterminism error.

## notes

Initial value of notes field.

## output

Format of output.
Options: table, json, card.

## overlap-policy

Overlap policy.
Options: Skip, BufferOne, BufferAll, CancelOther, TerminateOther, AllowAll.

## pager

Sets the pager for the Temporal CLI to use.
Options are less, more, and favoritePager.

## pause-on-failure

Pause schedule after any Workflow failure.

## pause

Pauses the Schedule.

## port

Port for the frontend gRPC service.

## promote-global

Promote local Namespace to Global Namespace.

## query

Provides a SQL-like Query of Search Attributes to return Workflow Executions to reset.
For more information, refer to the [`temporal workflow list`](/cli/workflow#list) command.

## raw

Print raw data in a JSON format.
For scripting, we recommend using this option instead of `-o json`.

## reachability-type

Specify how you'd like to filter the reachability of Build IDs.
The following are valid choices:

- `open`: reachable by one or more open Workflows.
- `closed`: reachable by one or more closed Workflows.
- `existing`: reachable by either open or closed Workflows.

Build IDs that are reachable by new Workflows are always reported.

## reapply-type

Event types to reapply after the reset point.
Options: Signal, None.

## reason

Reason for the operation.

## reject-condition

Optional flag for rejecting Queries based on Workflow state.
Valid values are "not_open" and "not_completed_cleanly".

## remaining-actions

Total number of actions allowed.

## reset-points

Only show Workflow Events that are eligible for reset.

## result

Set the result value of Activity completion.

## retention

Workflow Execution retention.

## run-id

Identifies the current Workflow Run.

## run-timeout

Timeout (in seconds) of a single Workflow run.

## schedule-id

Schedule Id.

## search-attribute

Set Search Attribute on a Schedule (formatted as `key=value`).
Use valid JSON formats for value.

## set-as-default

When set, establishes the compatible set being targeted as the default for the Task Queue.

If a different set is the current default, the targeted set replaces it.

## skip-base-is-not-current

Skip a Workflow Execution if the base Workflow Run is not the current Workflow Run.

## skip-current-open

Skip a Workflow Execution if the current Run is open for the same Workflow Id as the base Run.

## sqlite-pragma

Specify sqlite pragma statements in pragma=value format.
Pragma options: ["journal_mode" "synchronous"].

## start-delay

Specify a delay before the workflow starts.

## start-time

Backfill start time.

## target-namespace

Namespace in which a handler Worker will poll for Nexus tasks.

## target-task-queue

Task Queue in which a handler Worker will poll for Nexus tasks.

## target-url

An external Nexus Endpoint where Nexus requests are forwarded to.
May be used as an alternative to `--target-namespace` and `--target-task-queue`.

:::note

Caution: `--target-url` is experimental.

:::

## task-queue-type

Task Queue type, which can be either workflow or activity.
The default type is workflow.

## task-queue

Task Queue.

## task-timeout

Start-to-close timeout for a Workflow Task (in seconds).

## time-format

Format time as: relative, iso, raw.

## time-zone

Time zone (IANA name).

## tls-ca-data

Data for server CA certificate. Can't be used with --tls-ca-path.

## tls-ca-path

Path to server CA certificate.

## tls-cert-data

Data for x509 certificate. Can't be used with --tls-cert-path.

## tls-cert-path

Path to x509 certificate.

## tls-disable-host-verification

Disables TLS host name verification.

## tls-key-data

Private certificate key data. Can't be used with --tls-key-path.

## tls-key-path

Path to private certificate key.

## tls-server-name

Overrides the target TLS server name.

## tls

Enable TLS encryption without additional options such as mTLS or client certificates.

## type

Search attribute type.
Options: Text, Keyword, Int, Double, Bool, Datetime, KeywordList.

## ui-asset-path

UI Custom Assets path.

## ui-codec-endpoint

UI Remote data converter HTTP endpoint.

## ui-ip

IPv4 address to bind the Web UI to.

## ui-port

Port for the Web UI.
Default: `--port` + 1000 (for example, 4000).

## unpause

Unpauses the Schedule.

## unset-description

Unset the description.

## verbose

Print applied Namespace changes.

## visibility-archival-state

Visibility Archival state.
Valid values: "disabled", "enabled".

## visibility-uri

Specify URI for Visibility Archival.
This cannot be changed after Archival is enabled.

## workflow-id

Workflow Id.

## workflow-type

Workflow type name.

## yes

Confirm all prompts.
